Inscoper::DeviceConfig¶

DeviceConfig class provides information for device configuration. More...

#include <DeviceConfig.h>

Public Functions¶

	Name
	DeviceConfig(Inscoper::EDriverType driverType) Constructor.
void	fromXML(Inscoper::XMLNode & deviceNode) Load from XML.
void	toXML(Inscoper::XMLNode & xmlParent) Save to XML.
const std::string &	getId() const Get the ID of the device.
void	setId(const std::string & id) Set the ID of the device.
const std::string &	getMetaDeviceId() const Get the meta device ID.
void	setMetaDeviceId(const std::string & metaDeviceId) Set the meta device ID.
Inscoper::EDriverType	getDriverType() const Get the driver type of the device.
void	setDriverType(Inscoper::EDriverType driverType) Set the driver type of the device.
Inscoper::NBO::ENBOType	getNBOType() const Get the NBO type of the device.
bool	hasNBOType() const Check if the NBO type of the device is set.
void	setNBOType(Inscoper::NBO::ENBOType nboType) Set the NBO type of the device.
void	unsetNBOType() Unset the NBO type of the device.
const std::vector< Inscoper::SubDeviceGroupConfigPtr > &	getSubDeviceGroupConfigList() const Get the sub-device group configuration list.
void	setSubDeviceGroupConfigList(const std::vector< Inscoper::SubDeviceGroupConfigPtr > & subDeviceGroups) Set the sub-device group configuration list.
void	addSubDeviceGroupConfig(const Inscoper::SubDeviceGroupConfigPtr & subDeviceGroup) Add a sub-device group configuration to the list.
const Inscoper::DriverConfigPtr &	getDriverConfig() const Get the driver configuration.
void	setDriverConfig(const Inscoper::DriverConfigPtr & driverConfig) Set the driver configuration.

Detailed Description¶

class Inscoper::DeviceConfig;

DeviceConfig class provides information for device configuration.

This class holds the configuration parameters for a specific device, including its ID, driver type, sub-device groups, and driver-specific settings.

Public Functions Documentation¶

function DeviceConfig¶

explicit DeviceConfig(
    Inscoper::EDriverType driverType
)

Constructor.

Parameters:

driverType : The driver type of the device

Initializes a new instance of DeviceConfig with the specified driver type.

function fromXML¶

void fromXML(
    Inscoper::XMLNode & deviceNode
)

Load from XML.

Parameters:

deviceNode : The XML node containing device information

Exceptions:

InscoperException If an error occurs

Populates the device configuration from the provided XML node.

function toXML¶

void toXML(
    Inscoper::XMLNode & xmlParent
)

Save to XML.

Parameters:

xmlParent : The parent XML node

Exceptions:

InscoperException If an error occurs

Serializes the device configuration to the specified parent XML node.

function getId¶

const std::string & getId() const

Get the ID of the device.

Return: The ID of the device

Retrieves the unique identifier of the device.

function setId¶

void setId(
    const std::string & id
)

Set the ID of the device.

Parameters:

id : The ID of the device

Assigns a unique identifier to the device.

function getMetaDeviceId¶

const std::string & getMetaDeviceId() const

Get the meta device ID.

Return: The meta device ID

Retrieves the meta device ID this device belongs to. Empty string if the device is standalone.

function setMetaDeviceId¶

void setMetaDeviceId(
    const std::string & metaDeviceId
)

Set the meta device ID.

Parameters:

metaDeviceId : The meta device ID

Assigns the meta device ID this device belongs to. Set to empty string for standalone devices.

function getDriverType¶

Inscoper::EDriverType getDriverType() const

Get the driver type of the device.

Return: The driver type of the device

Retrieves the type of driver associated with this device.

function setDriverType¶

void setDriverType(
    Inscoper::EDriverType driverType
)

Set the driver type of the device.

Parameters:

driverType : The driver type of the device

Sets the type of driver for this device.

function getNBOType¶

Inscoper::NBO::ENBOType getNBOType() const

Get the NBO type of the device.

Return: The NBO type of the device

Retrieves the NBO type of the device.

function hasNBOType¶

bool hasNBOType() const

Check if the NBO type of the device is set.

Return: True if the NBO type is set, false otherwise

Checks whether an NBO type has been explicitly defined for this device.

function setNBOType¶

void setNBOType(
    Inscoper::NBO::ENBOType nboType
)

Set the NBO type of the device.

Parameters:

nboType : The NBO type of the device

Sets the NBO type of the device.

function unsetNBOType¶

void unsetNBOType()

Unset the NBO type of the device.

Removes the NBO type definition, making hasNBOType() return false.

function getSubDeviceGroupConfigList¶

const std::vector< Inscoper::SubDeviceGroupConfigPtr > & getSubDeviceGroupConfigList() const

Get the sub-device group configuration list.

Return: The list of sub-device group configurations

Retrieves the list of sub-device group configurations associated with this device.

function setSubDeviceGroupConfigList¶

void setSubDeviceGroupConfigList(
    const std::vector< Inscoper::SubDeviceGroupConfigPtr > & subDeviceGroups
)

Set the sub-device group configuration list.

Parameters:

subDeviceGroups : The list of sub-device group configurations

Replaces the current list of sub-device group configurations.

function addSubDeviceGroupConfig¶

void addSubDeviceGroupConfig(
    const Inscoper::SubDeviceGroupConfigPtr & subDeviceGroup
)

Add a sub-device group configuration to the list.

Parameters:

subDeviceGroup : The sub-device group configuration to add

Appends a new sub-device group configuration to the device.

function getDriverConfig¶

const Inscoper::DriverConfigPtr & getDriverConfig() const

Get the driver configuration.

Return: The driver configuration

Retrieves the specific configuration for the underlying driver.

function setDriverConfig¶

void setDriverConfig(
    const Inscoper::DriverConfigPtr & driverConfig
)

Set the driver configuration.

Parameters:

driverConfig : The driver configuration

Assigns the specific configuration for the underlying driver.

Updated on 2026-06-23 at 10:35:19 +0200